ExportOptions Object

The ExportOptions object provides properties and methods for retrieving information and setting options for exporting your report (that is, export format, destination, etc.). An ExportOptions Object is obtained from the ExportOptions property of the Report Object.

ExportOptions Object Properties

Property Description Read/Write Restriction in event handler

ApplicationFile
Name

String. Gets or sets the destination application file name.

Read/Write

Set before exporting report to an application destination.

CharFieldDelimiter

String. Gets or sets the character used to separate fields in character separated text formats. This character delimits every field in the file.

Read/Write

None

CharStringDelimiter

String. Gets or sets the character used to separate strings in character separated text formats. This character delimits only string fields (numeric, date fields, etc., have no delimiter).

Read/Write

None

DestinationDLL
Name

String. Gets the Internal Name property of the DLL used to export the report to a certain destination. The destination is set in the DestinationType property.

Read only

None

DestinationType

CRExportDestinationType. Gets or sets the export destination type.

Read/Write

None

DiskFileName

String. Gets or sets the file name if the report is exported to a disk.

When exporting to HTML use HTMLFileName. When exporting to XML use XMLFileName.

Read/Write

None

ExcelAreaGroup
Number

Integer. Gets or sets the base area group number if the area type is group area when exporting to Excel.

Read/Write

None

ExcelAreaType

CRAreaKind. Gets or sets the base area type if not using constant column width when exporting to Excel.

Read/Write

None

ExcelConstant
ColumnWidth

Double. Gets or sets the column width when exporting to Excel.

Read/Write

None

ExcelTabHas
ColumnHeadings

Boolean. Gets or sets exporting to Excel has column headings option.

Read/Write

None

ExcelUseConstant
ColumnWidth

Boolean. Gets or sets export to Excel to use constant column width.

Read/Write

None

ExcelUseTabular
Format

Boolean. Gets or sets exporting to Excel to use tabular format.

Read/Write

None

ExcelUseWorksheet
Functions

Boolean. Gets or sets export to Excel to use worksheet functions to represent subtotal fields in the report.

Read/Write

None

Exchange
DestinationType

CRExchangeDestinationType. Gets or sets the Exchange destination type for reports exported to Exchange folders.

Read/Write

None

ExchangeFolderPath

String. Gets or sets the path of the Exchange folder for reports exported to Exchange (for example, "MyFolders@Inbox").

Read/Write

None

ExchangePassword

String. Sets Exchange password.

Write only

None

ExchangeProfile

String. Gets or sets a user profile for accessing an Exchange folder for reports exported to Exchange.

Read/Write

None

ExchangePathHas
ColumnHeadings

Boolean. Gets or sets the column heading option when exporting to Exchange.

Read/Write

None

FormatDLLName

String. Gets the Internal Name property of the DLL used to export the report to a certain format type. The export format type is set in the FormatType property.

Read only

None

FormatType

CRExportFormatType. Gets or sets the format type for the exported report (for example, text, Excel, etc.).

Read/Write

None

HTMLEnable
SeperatedPages

Boolean. Gets or sets the option to create seperated pages when exporting to HTML format.

Read/Write

None

HTMLFileName

String. Gets or sets the HTML file name for reports exported to HTML format.

Read/Write

None

HTMLHasPage
Navigator

Boolean. Gets or sets the option to display a page navigator on each page of a report exported to HTML format.

Read/Write

None

LotusDomino
Comments

String. Gets or sets the destination Lotus Domino comments.

Read/Write

None

LotusDomino
DatabaseName

String. Gets or sets the destination Lotus Domino database name.

Read/Write

None

LotusNotesForm
Name

String. Gets or sets the destination Lotus Domino form name.

Read/Write

None

MailBccList

String. Gets or sets a Blind Carbon Copy (BCC) list for reports e-mailed to a VIM
e-mail account.

Read/Write

None

MailCcList

String. Gets or sets a Carbon Copy (CC) list for reports e-mailed.

Read/Write

None

MailMessage

String. Gets or sets the e-mail message included with e-mailed reports.

Read/Write

None

MailSubject

String. Gets or sets the e-mail subject heading for reports being e-mailed.

Read/Write

None

MailToList

String. Gets or sets the To list for reports being e-mailed.

Read/Write

None

NumberOfLines
PerPage

Integer. Gets or sets the number of lines to appear per page option for reports exported to a paginated text format.

Read/Write

None

ODBC
DataSourceName

String. Gets or sets the ODBC data source for reports exported to ODBC.

Read/Write

None

ODBCDataSource
Password

String. Sets the ODBC data source password.

Write only

None

ODBCDataSource
UserID

String. Gets or sets the user name used to access an ODBC data source for reports exported to ODBC.

Read/Write

None

ODBCExportTable
Name

String. Gets or sets the database table in the ODBC data source that the report file exported to ODBC will be appended to. You can also create a new table using this property.

Read/Write

None

PDFExportAllPages

Boolean. Gets or sets wether or not to export all pages of the report to Portable Document Format(PDF). PDFExportAllPages must be set to false when setting PDFFirstPageNumber and PDFLastPageNumber.

Read/Write

None

PDFFirstPage
Number

Long. Gets or sets the start page, of a page export range, when exporting to PDF. PDFExportAllPages must be set to False or this value is ignored.

Read/Write

None

PDFLastPage
Number

Long. Gets or sets the end page, of a page export range, when exporting to PDF. PDFExportAllPages must be set to False or this value is ignored.

Read/Write

None

Parent

Report Object. Reference to the parent object.

Read only

None

RTFExportAllPages

Boolean. Gets or sets wether or not to export all pages of the report to Rich Text Format(RTF). RTFExportAllPages must be set to false when setting RTFFirstPageNumber and RTFLastPageNumber.

Read/Write

None

RTFFirstPage
Number

Long. Gets or sets the start page, of a page export range, when exporting to RTF. RTFExportAllPages must be set to False or this value is ignored.

Read/Write

None

RTFFLastPage
Number

Long. Gets or sets the end page, of a page export range, when exporting to RTF. RTFExportAllPages must be set to False or this value is ignored.

Read/Write

None

UseReportDate
Format

Boolean. Gets or sets whether the date format used in the report should also be used in the exported report. Can be used for Data Interchange Format (DIF), Record Style Format, and comma, tab, or character separated format.

Read/Write

None

UseReportNumber
Format

Boolean. Gets or sets whether the number format used in the report should also be used in the exported report. Can be used for Data Interchange Format (DIF), Record Style Format, and comma, tab, or character separated format.

Read/Write

None

XMLAllowMultiple
Files

Boolean. Gets or sets allow multiple files, when exporting to XML. When set to True the Schema file for the report will be exported along with the XML file. The Schema file will be either an XML schema (.xsd) or a Document Type Definition (.dtd), depending on the options selected in the XML Forma dilaog box. For more information see "Customizing XML report definitions" in the Crystal Reports Users Guide.

Read/Write

None

XMLFileName

String. Gets or sets the file name if the report is exported to a disk.

Read/Write

None

Remarks

For backwards compatibility the FormatDllName and DestinationDllName properties return the Internal Name property of the associated DLL. The Internal Name property of the DLL is found in the DLLs Properties Dialog box under the Version tab. For a list of export DLLs see "Export Destination" and "Export Format" in the Runtime help (Runtime.hlp).



Seagate Software IMG Holdings, Inc.
http://www.seagatesoftware.com
Support services:
http://support.seagatesoftware.com